home *** CD-ROM | disk | FTP | other *** search
/ Libris Britannia 4 / science library(b).zip / science library(b) / PROGRAMM / DB_CLIPP / 0643C.ZIP / DBINDENT.DOC < prev    next >
Text File  |  1987-05-31  |  8KB  |  267 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                               dbindent (tm)
  22.                           User's Documentation
  23.  
  24.  
  25.                               Version  1.0
  26.                                March 1986
  27.  
  28.  
  29.  
  30.          Copyright (C) 1985,1986  Kelferama , Ltd. and Steve Kelfer
  31.                           All Rights Reserved
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.                               dbindent (tm)
  70.  
  71.  
  72.     Use Restrictions and Registration :  This product is copyright (C) 1985
  73. ,1986 by Kelferama, Ltd.  and Steve Kelfer.  All rights reserved.
  74. Non-registered users are granted a limited license to use this program on a
  75. trial basis , and to copy the program for trail use by others subject to
  76. the following conditions:
  77.  
  78.               The program is distributed in unmodified form, complete with
  79. this documentation.
  80.  
  81.               No fee , charge , or other consideration , or renumeration is
  82. requested or accepted.
  83.  
  84.               The program is not reproduced in mass or ditributed in
  85. conjunction with any other product.
  86.  
  87.         If you like this product and intend to use it on an ongoing basis
  88. you are required to register this product and show your support for its
  89. author. Commercial use by business or governmental agencies is strictly
  90. prohibited.
  91.  
  92.         This product is designed to aid the dbase programmer and is
  93. intended primarily for dbase III and dbase III Plus. but is not limited
  94. therein. Any comments and suggestions are welcomed and should be addressed
  95. to the board on which you found this product , or if you prefer , you may
  96. send written inquiries and comments to the address listed below.
  97.  
  98.         You may register this product with us by sending a check or money
  99. order for $10 to :
  100.  
  101.                            Kelferama, Ltd.
  102.                            400 S. Flores
  103.                            San Antonio, Tx. 78204
  104.  
  105.         Registered users will be notified of upcoming revisions of this
  106. product as well as other dbase tools and utilities we have available. Any
  107. updates of this program will be provided free of charge upon request.
  108. Program disks , however are not included in registration fees. In addition,
  109. any service or questions addressed to this product will be supplied to
  110. registered users only.
  111.  
  112.          Registered users may also request additional copies without the
  113. inconvience or expense of downloading , if they prefer , by sending a blank
  114. formatted disk to the above address together with a self-addressed postage
  115. paid return mailer. Your copy , together with documentation , will be
  116. sent to you return mail on the user's disc. Updates can also be obtained by
  117. registered users in this same manner.
  118.  
  119.          Remember, this is user supported software. We encourage you to
  120. copy it and pass it along to friends as well as upload to public bulletin
  121. boards. Registration is voluntary on your part , however , essential for
  122. the continual revision and improvement of this and related products. Please
  123. remember the author and register this product. We beleive the fee is indeed
  124. a nominal one and well worth the value of the product.
  125.  
  126.           Thank you.
  127.  
  128.  
  129.          Copyright (C) 1985,1986  Kelferama , Ltd. and Steve Kelfer
  130.  
  131.  
  132.  
  133.  
  134.                               dbindent (tm)
  135.  
  136.  
  137.     Breif Desription :  dBindent is a formatting utility for dBase program
  138. files.  It provides automatic indentation and error detection of condition-
  139. al structures as well as set of optional switches that include :
  140.  
  141.                         1) screen control
  142.                         2) case conversion
  143.                         3) blank line removal / addition
  144.  
  145.     Basic Syntax : dbindent [filename] {option switches}
  146.  
  147.                    option switches :
  148.                         1) -S/s  - display file to screen
  149.                         2) -L/l  - display lineno 's
  150.                         3) -C/c  - Upper/lower case conversion
  151.                         4) -B/b  - remove blank lines
  152.                         5) +B/b  - add blank lines
  153.  
  154.     All option switches must be separated by at least one blank space.
  155.  
  156.     Explanation of option switches :
  157.  
  158.     1) Screen Control :  "-s" or "-S" displays file to screen as it is
  159. formatted . Outputting display will slow the processing somewhat.
  160.  
  161.     2) Line no's :  "-L" or "-l" displays lineno's as each line of file is
  162. processed. It is not necessary to display file to screen to display lineno's.
  163.  
  164.     3) Case conversion : "-C" will perform Upper case conversion. "-c" will
  165. perform lower case conversion. Conversion applies to all commands except
  166. those found after "@ say" commands and text within a text/endtext block.
  167.  
  168.     4) Blank Lines :  "-B" or "-b" will remove all blank lines from program
  169. file.  "+B" or "+b" will insert blank lines immediately before each cond-
  170. itional statemant and immediately following the close of each conditional
  171. structure.  This helps further set off conditional branches, especially
  172. when nesting is several levels deep. Note that both switches can be used
  173. simultaneously. This will first remove all blank lines in the file in then
  174. insert lines only before and after each conditional structures.
  175.  
  176.    Examples : dbindent [filename]
  177.               This will simply indent file
  178.  
  179.               dbindent [filename] -s -l
  180.               This will indent file, display output to screen with lineno's
  181.  
  182.               dbindent [filename] -s -l -b
  183.               This will indent file , display to screen with lineno's, and
  184. remove all blank lines in file.
  185.  
  186.               dbindent [filename] -c
  187.               This will indent file and convert all command lines to
  188. lowercase (except for @say statements and text/endtext blocks).
  189.  
  190.               dbindent [filename] -s -l -C -b +b
  191.               This will indent file, display file on screen with lineno's
  192. convert all command lines to uppercase, remove blank lines, and then insert
  193. blank lines immediately before and after conditional structures.
  194.  
  195.  
  196.          Copyright (C) 1985,1986  Kelferama , Ltd. and Steve Kelfer
  197.  
  198.  
  199.  
  200.  
  201.                               dbindent (tm)
  202.  
  203.  
  204.  
  205.     Notes on usage :  Simply running dbindent with no option switches will
  206. provide the fastest execution , averaging 1800 to 2500 lines a minute on an
  207. average file (utilizing standard PC).  The only switch that can slow
  208. execution time noticeably is screen output.  The overhead involved here
  209. slows the process down by 50% on most systems.  Although the other switches
  210. provide some additional overhead, their effect on execution time is
  211. minimal.
  212.  
  213.     There is some schools of thought that indented files, though they are
  214. easier to read, slow execution of the interpreter.  While this is
  215. theoretically true, my tests have shown this to be of little consequence in
  216. most cases.  In any case, should you decide that it is necessary, you can
  217. rename your indented file with a differant extension, and then use a
  218. program such as dCrunch to compress file.  You can find some discussion on
  219. this subject in recent issues of Databased Advisor ,if it concerns you.
  220.  
  221.  
  222.     Upon completion of file processing, you will be notified of the total
  223. number of lines now in the file , the total number of "do while"s and
  224. "enddo"s, "do case"s and "endcases" , and "if"s and "endif"s. Any
  225. incompleted conditional structures will be called to your attention and
  226. explained breifly. This is a common programming error amongst even more
  227. proficient dbase programmers. (Improperly nested structures also cause
  228. havoc and are sometimes harder to find, especially in larger files. These
  229. errors can be detected with another Kelferama product called nestchek.
  230. Registration of this product entitles the user to obtain this and other
  231. associated products.)
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.          Copyright (C) 1985,1986  Kelferama , Ltd. and Steve Kelfer
  264.  
  265.  
  266.  
  267.